Orchestration SDK 5.13.2
Loading...
Searching...
No Matches
<OrchestrationErrorDelegate> Protocol Reference

#include <OrchestrationErrorDelegate.h>

Inherits <NSObject>.

Instance Methods

(void) - orchestrationError:withCommand:
 
(void) - orchestrationServerError:
 

Detailed Description

The OrchestrationErrorDelegate interface defines the delegate that must be implemented in order to be informed of errors during the OrchestrationProtocol lifecycle.

Since it is the main way for the OrchestrationProtocol to report errors it must be provided to the OrchestratorBuilder via OrchestratorBuilder#setErrorDelegate:(id<OrchestrationErrorDelegate>).
The OrchestrationErrorDelegate used by the OrchestrationProtocol can also be modified during its lifecycle via OrchestrationProtocol#setErrorDelegate:(id<OrchestrationErrorDelegate>).

Method Documentation

◆ orchestrationError:withCommand:

- (void) orchestrationError: (OrchestrationError *) error
withCommand: (NSString *_Nullable) command 

delegate that will be called when an error occurs

Parameters
errorerror to return
command- Optional command that can be sent to the server to notify about the failure

◆ orchestrationServerError:

- (void) orchestrationServerError: (OrchestrationServerError *) error

delegate that will be called when an error occurs on the server and is sent back to the client

Parameters
errorerror to be returned

The documentation for this protocol was generated from the following file: